home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 7: Sunsite / Linux Cubed Series 7 - Sunsite Vol 1.iso / system / filesyst / ext2 / ext2ed-0.000 / ext2ed-0 / ext2ed-0.1 / doc / user-guide-0.1.sgml < prev   
SGML Document  |  1995-08-23  |  42KB

  1. <!doctype linuxdoc system>
  2.  
  3. <!-- EXT2ED user's guide -->
  4. <!-- First written: July 22 1995 -->
  5. <!-- Last  updated: August 3 1995 -->
  6. <!-- This document is written Using the Linux documentation project Linuxdoc-SGML DTD -->
  7.  
  8. <article>
  9.  
  10. <title>EXT2ED - The Extended-2 filesystem editor - User's guide
  11. <author>Gadi Oxman, tgud@tochnapc2.technion.ac.il
  12. <date>v0.1, August 3 1995
  13. <abstract>
  14. This is only the initial version of this document. It may be unclear at
  15. some places. Please send me feedback with anything regarding to it.
  16. </abstract>
  17. <toc>
  18.  
  19. <!-- Begin of document -->
  20.  
  21. <sect>About EXT2ED documentation
  22. <p>
  23.  
  24. The EXT2ED documentation consists of three parts:
  25. <itemize>
  26. <item>    The ext2 filesystem overview.
  27. <item>    The EXT2ED user's guide.
  28. <item>    The EXT2ED design and implementation.
  29. </itemize>
  30.  
  31. If you intend to used EXT2ED, I strongly suggest that you would be familiar
  32. with the material presented in the <tt>ext2 filesystem overview</> as well.
  33.  
  34. If you also intend to browse and modify the source code, I suggest that you
  35. will also read the article <tt>The EXT2ED design and implementation</>, as it
  36. provides a general overview of the structure of my source code.
  37.  
  38. <sect>Introduction
  39.  
  40. <p>
  41. EXT2ED is a "disk editor" for the ext2 filesystem. Its purpose is to show
  42. you the internal structures of the ext2 filesystem in an rather intuitive
  43. and logical way, so that it will be easier to "travel" between the various
  44. internal filesystem structures. 
  45.  
  46. <sect>Basic concepts in EXT2ED
  47.  
  48. <p>
  49. Two basic concepts in EXT2ED are <tt>commands</> and <tt>types</>.
  50.  
  51. EXT2ED is object-oriented in the sense that it defines objects in the
  52. filesystem, like a <tt>super-block</> or a <tt>directory</>. An object is
  53. something which "knows" how to handle some aspect of the filesystem.
  54.  
  55. Your interaction with EXT2ED is done through <tt>commands</> which EXT2ED
  56. accepts. There are three levels of commands:
  57. <itemize>
  58. <item>    General Commands
  59. <item>    Extended-2 Filesystem general commands
  60. <item>    Type specific commands
  61. </itemize>
  62. The General commands are always available.
  63.  
  64. The ext2 general commands are available only when editing an ext2 filesystem.
  65.  
  66. The Type specific commands are available when editing a specific object in the
  67. filesystem. Each object typically comes with its own set of internal
  68. variables, and its own set of commands, which are fine tuned handle the
  69. corresponding structure in the filesystem.
  70. <sect>Running EXT2ED
  71. <p>
  72. Running EXT2ED is as simple as typing <tt>ext2ed</> from the shell prompt.
  73. There are no command line switches.
  74.  
  75. When first run, EXT2ED parses its configuration file, <tt>ext2ed.conf</>.
  76. This file must exist.
  77.  
  78. When the configuration file processing is done, EXT2ED screen should appear
  79. on the screen, with the command prompt <tt>ext2ed></> displayed.
  80.  
  81. <sect>EXT2ED user interface
  82.  
  83. <p>
  84. EXT2ED uses the <em>ncurses</> library for screen management. Your screen
  85. will be divided into four parts, from top to bottom:
  86. <itemize>
  87. <item> Title window
  88. <item> Status window
  89. <item> Main editing window
  90. <item> Command window
  91. </itemize>
  92. The title window just displays the current version of EXT2ED.
  93.  
  94. The status window will display various information regarding the state of
  95. the editing at this point.
  96.  
  97. The main editing window is the place at which the actual data will be shown.
  98. Almost every command will cause some display at this window. This window, as
  99. opposed to the three others, is of variable length - You always look at one
  100. page of it. The current page and the total numbers of pages at this moment
  101. is displayed at the status window. Moving between pages is done by the use
  102. of the <tt>pgdn</> and <tt>pgup</> commands.
  103.  
  104. The command window is at the bottom of the screen. It always displays a
  105. command prompt <tt>ext2ed></> and allows you to type a command. Feedback
  106. about the commands entered is displayed to this window also.
  107.  
  108. EXT2ED uses the <em>readline</> library while processing a command line. All
  109. the usual editing keys are available. Each entered command is placed into a
  110. history of commands, and can be recalled later. Command Completion is also
  111. supported - Just start to type a command, and press the completion key.
  112.  
  113. Pressing <tt>enter</> at the command window, without entering a command,
  114. recalls the last command. This is useful when moving between close entries,
  115. in the <tt>next</> command, for example.
  116.  
  117. <sect>Getting started
  118.  
  119. <p>
  120.  
  121. <sect1>A few precautions
  122.  
  123. <p>
  124.  
  125. EXT2ED is a tool for filesystem <tt>editing</>. As such, it can be
  126. <tt>dangerous</>. The summary to the subsections below is that
  127. <tt>You must know what you are doing</>.
  128.  
  129. <sect2><label id="mounted_ref">A mounted filesystem
  130.  
  131. <p>
  132.  
  133. EXT2ED is not designed to work on a mounted filesystem - It is complicated
  134. enough as it is; I didn't even try to think of handling the various race
  135. conditions. As such, please respect the following advice:
  136.  
  137. <tt>Do not use EXT2ED on a mounted filesystem !</>
  138.  
  139. EXT2ED will not allow write access to a mounted filesystem. Although it is
  140. fairly easy to change EXT2ED so that it will be allowed, I hereby request
  141. again- EXT2ED is not designed for that action, and will most likely corrupt
  142. data if used that way. Please don't do that.
  143.  
  144. Concerning read access, I chose to leave the decision for the user through
  145. the configuration file option <tt>AllowMountedRead</>. Although read access
  146. on a mounted partition will not do any damage to the filesystem, the data
  147. displayed to you will not be reliable, and showing you incorrect information
  148. may be as bad as corrupting the filesystem. However, you may still wish to
  149. do that.
  150.  
  151. <sect2>Write access
  152.  
  153. <p>
  154.  
  155. Considering the obvious sensitivity of the subject, I took the following
  156. actions:
  157.  
  158. <enum>
  159. <item>    EXT2ED will always start with a read-only access. Write access mode
  160.     needs to be specifically entered by the <tt>enablewrite</> command.
  161.     Until this is done, no write will be allowed. Write access can be
  162.     disabled at any time with <tt>disablewrite</>. When
  163.     <tt>enablewrite</> is issued, the device is reopened in read-write
  164.     mode. Needless to say, the device permissions should allow that.
  165. <item>    As a second level of protection, you can disallow write access in
  166.     the configuration file by using the <tt>AllowChanges off</>
  167.     configuration option. In this case, the <tt>enablewrite</> command
  168.     will be refused.
  169. <item>    When write access is enabled, the data will never change
  170.     immediately. Rather, a specific <tt>writedata</> command is needed
  171.     to update the object in the disk with the changed object in memory.
  172. <item>    In addition, A logging option is provided through the configuration
  173.     file options <tt>LogChanges</> and <tt>LogFile</>. With logging
  174.     enabled, each change to the disk will be logged at a very primitive
  175.     level - A hex dump of the original data and of the new written data.
  176.     The log file will be a text file which is easily readable, and you
  177.     can make use of it to undo any changes which you made (EXT2ED doesn't
  178.     make use of the log file for that purpose, it just logs the changes).
  179. </enum>
  180. Please remember that this is only the initial release of EXT2ED, and it is
  181. not very much tested - It is reasonable to assume that <tt>there are
  182. bugs</>.
  183. However, the logging option above can offer protection even from this
  184. unfortunate case. Therefor, I highly recommend that at least when first
  185. working with EXT2ED, the logging option will be enabled, despite the disk
  186. space which it consumes.
  187.  
  188. <sect1><label id="help_ref">The help command
  189.  
  190. <p>
  191.  
  192. When loaded, EXT2ED will show a short help screen. This help screen can
  193. always be retrieved by the command <tt>help</>. The help screen displays a
  194. list of all the commands which are available at this point. At startup, only
  195. the <tt>General commands</> are available.
  196. This will change with time, since each object has its own commands. Thus,
  197. commands which are available now may not be available later.
  198. Using <tt>help</> <em>command</> will display additional information about
  199. the specific command <em>command</>.
  200.  
  201. <sect1><label id="setdevice_ref">The setdevice command
  202.  
  203. <p>
  204.  
  205. The first command that is usually entered to EXT2ED is the <tt>setdevice</>
  206. command. This command simply tells EXT2ED on which device the filesystem is
  207. present. For example, suppose my ext2 filesystem is on the first partition
  208. of my ide disk. The command will be:
  209. <tscreen><verb>
  210. setdevice /dev/hda1
  211. </verb></tscreen>
  212. The following actions will take place in the following order:
  213. <enum>
  214. <item>    EXT2ED will check if the partition is mounted.
  215.     If the partition is mounted (<tt>highly not recommended</>),
  216.     the accept/reject behavior will be decided by the configuration
  217.     file. Cross reference section <ref id="mounted_ref">.
  218. <item>    The specified device will be opened in read-only mode. The
  219.     permissions of the device should be set in a way that allows
  220.     you to open the device for read access.
  221. <item>    Autodetection of an ext2 filesystem will be made by searching for
  222.     the ext2 magic number in the main superblock.
  223. <item>    In the case of a successful recognition of an ext2 filesystem, the
  224.     ext2 filesystem specific commands and the ext2 specific object
  225.     definitions will be registered. The object definitions will be read
  226.     at run time from a file specified by the configuration file.
  227.  
  228.     In case of a corrupted ext2 filesystem, it is quite possible that
  229.     the main superblock is damaged and autodetection will fail. In that
  230.     case, use the configuration option <tt>ForceExt2 on</>. This is not
  231.     the default case since EXT2ED can be used at a lower level to edit a
  232.     non-ext2 filesystem.
  233. <item>    In a case of a successful autodetection, essential information about
  234.     the filesystem such as the block size will be read from the
  235.     superblock, unless the used overrides this behavior with an
  236.     configuration option (not recommended). In that case, the parameters
  237.     will be read from the configuration file.
  238.  
  239.     In a case of an autodetection failure, the essential parameters
  240.     will be read from the configuration file.
  241. </enum>
  242. Assuming that you are editing an ext2 filesystem and that everything goes
  243. well, you will notice that additional commands are now available in the help
  244. screen, under the section <tt>ext2 filesystem general commands</>. In
  245. addition, EXT2ED now recognizes a few objects which are essential to the
  246. editing of an ext2 filesystem.
  247.  
  248. <sect>Two levels of usage
  249.  
  250. <p>
  251.  
  252. <sect1>Low level usage
  253.  
  254. <p>
  255. This section explains what EXT2ED provides even when not editing an ext2
  256. filesystem.
  257.  
  258. Even at this level, EXT2ED is more than just a hex editor. It still allows
  259. definition of objects and variables in run time through a user file,
  260. although of-course the objects will not have special fine tuned functions
  261. connected to them. EXT2ED will allow you to move in the filesystem using
  262. <tt>setoffset</>, and to apply an object definition on a specific place
  263. using <tt>settype</> <em>type</>. From this point and on, the object will
  264. be shown <tt>in its native form</> - You will see a list of the
  265. variables rather than just a hex dump, and you will be able to change each
  266. variable in the intuitive form <tt>set variable=value</>.
  267.  
  268. To define objects, use the configuration option <tt>AlternateDescriptors</>.
  269.  
  270. There are now two forms of editing:
  271. <itemize>
  272. <item>    Editing without a type. In this case, the disk block will be shown
  273. as a text+hex dump, and you will be able to move along and change it.
  274. <item>    Editing with a type. In this case, the object's variables will be
  275. shown, and you will be able to change each variable in its native form.
  276. </itemize>
  277.  
  278. <sect1>High level usage
  279.  
  280. <p>
  281. EXT2ED was designed for the editing of the ext2 filesystem. As such, it
  282. "understands" the filesystem structure to some extent. Each object now has
  283. special fine tuned 'C' functions connected to it, which knows how to display
  284. it in an intuitive form, and how the object fits in the general design of
  285. the ext2 filesystem. It is of-course much easier to use this type of
  286. editing. For example:
  287. <tscreen>
  288. Issue <em>group 2</> to look at the main copy of the third group block
  289. descriptor. With <em>gocopy 1</> you can move to its first backup copy,
  290. and with <em>inode</> you can start editing the inode table of the above
  291. group block. From here, if the inode corresponds to a file, you can
  292. use <em>file</> to edit the file in a "continuous" way, using
  293. <em>nextblock</> to pass to its next block, letting EXT2ED following by
  294. itself the direct blocks, indirect blocks, ..., while still preserving the
  295. actual view of the exact block usage of the file.
  296. </tscreen>
  297. The point is that the "tour" of the filesystem will now be synchronic rather
  298. than asynchronic - Each object has the "links" to pass between connected
  299. logical structures, and special fine-tuned functions to deal with it.
  300.  
  301. <sect>General commands
  302.  
  303. <p>
  304. I will now start with a systematic explanation of the general commands.
  305. Please feel free to experiment, but take care when using the
  306. <tt>enablewrite</> command.
  307.  
  308. Whenever a command syntax is specified, arguments which are optional are
  309. enclosed with square brackets.
  310.  
  311. Please note that in EXT2ED, each command can be overridden by a specific
  312. object to provide special fine-tuned functionality. In general, I was
  313. attempting to preserve the similarity between those functions, which are
  314. accessible by the same name.
  315.  
  316. <sect1><label id="disablewrite_ref">disablewrite
  317. <p>
  318. <tscreen><verb>
  319. Syntax: disablewrite
  320. </verb></tscreen>
  321. <tt>disablewrite</> is used to reopen the device with read-only access. When
  322. first running EXT2ED, the device is opened in read-only mode, and an
  323. explicit <tt>enablewrite</> is required for write access. When finishing
  324. with changing, a <tt>disablewrite</> is recommended for safety. Cross
  325. reference section <ref id="disablewrite_ref">.
  326.  
  327. <sect1><label id="enablewrite_ref">enablewrite
  328. <p>
  329. <tscreen><verb>
  330. Syntax: enablewrite
  331. </verb></tscreen>
  332. <tt>enablewrite</> is used to reopen the device with read-write access.
  333. When first running EXT2ED, the device is opened in read-only mode, and an
  334. explicit <tt>enablewrite</> is required for write access.
  335. <tt>enablewrite</> will fail if write access is disabled from the
  336. configuration file by the <tt>AllowChanges off</> configuration option.
  337. Even after <tt>enablewrite</>, an explicit <tt>writedata</>
  338. is required to actually write the new data to the disk.
  339. When finishing with changing, a <tt>disablewrite</> is recommended for safety.
  340. Cross reference section <ref id="enablewrite_ref">.
  341.  
  342. <sect1>help
  343. <p>
  344. <tscreen><verb>
  345. Syntax: help [command]
  346. </verb></tscreen>
  347. The <tt>help</> command is described at section <ref id="help_ref">. 
  348.  
  349. <sect1><label id="next_ref">next
  350. <p>
  351. <tscreen><verb>
  352. Syntax: next [number]
  353. </verb></tscreen>
  354. This section describes the <em>general command</> <tt>next</>. <tt>next</>
  355. is overridden by several types in EXT2ED, to provide fine-tuned
  356. functionality.
  357.  
  358. The <tt>next general command</> behavior is depended on whether you are editing a
  359. specific object, or none.
  360.  
  361. <itemize>
  362. <item>    In the case where Type is <tt>none</> (The current type is showed
  363.     on the status window by the <tt>show</> command), <tt>next</>
  364.     passes to the next <em>number</> bytes in the current edited block.
  365.     If <em>number</> is not specified, <em>number=1</> is assumed.
  366. <item>     In the case where Type is defined, the <tt>next</> commands assumes
  367.     that you are editing an array of objects of that type, and the
  368.     <tt>next</> command will just pass to the next entry in the array.
  369.     If <em>number</> is defined, it will pass <em>number</> entries
  370.     ahead.
  371. </itemize>
  372.  
  373. <sect1><label id="pgdn_ref">pgdn
  374. <p>
  375. <tscreen><verb>
  376. Syntax: pgdn
  377. </verb></tscreen>
  378. Usually the edited data doesn't fit into the visible main window. In this
  379. case, the status window will indicate that there is more to see "below" by
  380. the message <tt>Page x of y</>. This means that there are <em>y</> pages
  381. total, and you are currently viewing the <em>x</> page. With the <tt>pgdn</>
  382. command, you can pass to the next available page.
  383.  
  384. <sect1>pgup
  385. <p>
  386. <tscreen><verb>
  387. Syntax: pgup
  388. </verb></tscreen>
  389.  
  390. <tt>pgup</> is the opposite of <tt>pgdn</> - It will pass to the previous
  391. page. Cross reference section <ref id="pgdn_ref">.
  392.  
  393. <sect1>prev
  394. <p>
  395. <tscreen><verb>
  396. Syntax: prev [number]
  397. </verb></tscreen>
  398.  
  399. <tt>prev</> is the opposite of <tt>next</>. Cross reference section
  400. <ref id="next_ref">.
  401.  
  402. <sect1><label id="recall_ref">recall
  403. <p>
  404. <tscreen><verb>
  405. Syntax: recall object
  406. </verb></tscreen>
  407. <tt>recall</> is the opposite of <tt>remember</>. It will place you at the
  408. place you where when saving the object position and type information. Cross
  409. reference section <ref id="remember_ref">.
  410.  
  411. <sect1>redraw
  412. <p>
  413. <tscreen><verb>
  414. Syntax: redraw
  415. </verb></tscreen>
  416. Sometimes the screen display gets corrupted. I still have problems with
  417. this. The <tt>redraw</> command simply redraws the entire display screen.
  418.  
  419. <sect1><label id="remember_ref">remember
  420. <p>
  421. <tscreen><verb>
  422. Syntax: remember object
  423. </verb></tscreen>
  424. EXT2ED provides you <tt>memory</> of objects; While editing, you may reach an
  425. object which you will like to return to later. The <tt>remember</> command
  426. will store in memory the current place and type of the object. You can
  427. return to the object by using the <tt>recall</> command. Cross reference
  428. section <ref id="recall_ref">.
  429.  
  430. <tt>Note:</>
  431. <itemize>
  432. <item>    When remembering a <tt>file</> or a <tt>directory</>, the
  433.     corresponding inode will be saved in memory. The basic reason is that
  434.     the inode is essential for finding the blocks of the file or the
  435.     directory.
  436. </itemize>
  437.  
  438. <sect1>set
  439. <p>
  440. <tscreen><verb>
  441. Syntax: set [text || hex] arg1 [arg2 arg3 ...]
  442.  
  443. or
  444.  
  445. Syntax: set variable=value
  446. </verb></tscreen>
  447. The <tt>set</> command is used to modify the current data.
  448. The <tt>set general command</> behavior is depended on whether you are editing a
  449. specific object, or none.
  450.  
  451. <itemize>
  452. <item>    In the case where Type is <tt>none</>, the first syntax should be
  453.     used. The set command affects the data starting at the current 
  454.     highlighted position in the edited block.
  455.     <itemize>
  456.     <item>    When using the <tt>set hex</> command, a list of
  457.         hexadecimal bytes should follow.
  458.     <item>    When using the <tt>set text</> command, it should be followed
  459.         by a text string.
  460.     </itemize>
  461.     Examples:
  462.     <tscreen><verb>
  463.     set hex 09 0a 0b 0c 0d 0e 0f
  464.     set text Linux is just great !
  465.     </verb></tscreen>
  466. <item>     In the case where Type is defined, the second syntax should be used.
  467.     The set commands just sets the variable <em>variable</> with the
  468.     value <em>value</>.
  469. </itemize>
  470. In any case, the data is only changed in memory. For an actual update to the
  471. disk, use the <tt>writedata</> command.
  472.  
  473. <sect1>setdevice
  474. <p>
  475. <tscreen><verb>
  476. Syntax: setdevice device
  477. </verb></tscreen>
  478. The <tt>setdevice</> command is described at section <ref id="setdevice_ref">. 
  479.  
  480. <sect1>setoffset
  481. <p>
  482. <tscreen><verb>
  483. Syntax: setoffset [block || type] [+|-]offset
  484. </verb></tscreen>
  485. The <tt>setoffset</> command is used to move asynchronically inside the file
  486. system. It is considered a low level command, and usually should not be used
  487. when editing an ext2 filesystem, simply because movement is better
  488. utilized through the specific ext2 commands.
  489.  
  490. The <tt>offset</> is in bytes, and meanwhile should be positive and smaller
  491. than 2GB.
  492.  
  493. Use of the <tt>block</> modifier changes the counting unit to block.
  494.  
  495. Use of the <tt>+ or -</> modifiers signals that the offset is relative to
  496. the current position.
  497.  
  498. use of the <tt>type</> modifier is allowed only with relative offset. This
  499. modifier will multiply the offset by the size of the current type.
  500.  
  501. <sect1>settype
  502. <p>
  503. <tscreen><verb>
  504. Syntax: settype type || [none | hex]
  505. </verb></tscreen>
  506. The <tt>settype</> command is used to move apply the object definitions of
  507. the type <em>type</> on the current position. It is considered a low level
  508. command and usually should not be used when editing an ext2 filesystem since
  509. EXT2ED provides better tools. It is of-course very useful when editing a
  510. non-ext2 filesystem and using user-defined objects.
  511.  
  512. When <em>type</> is <em>hex</> or <em>none</>, the data will be displayed as
  513. a hex and text dump.
  514.  
  515. <sect1>show
  516. <p>
  517. <tscreen><verb>
  518. Syntax: show
  519. </verb></tscreen>
  520. The <tt>show</> command will show the data of the current object at the
  521. current position on the main display window. It will also update the status
  522. window with type specific information. It may be necessary to use
  523. <tt>pgdn</> and <tt>pgup</> to view the entire data.
  524.  
  525. <sect1>writedata
  526. <p>
  527. <tscreen><verb>
  528. Syntax: writedata
  529. </verb></tscreen>
  530. The <tt>writedata</> command will update the disk with the object data that
  531. is currently in memory. This is the point at which actual change is made to
  532. the filesystem. Without this command, the edited data will not have any
  533. effect. Write access should be allowed for a successful update.
  534.  
  535. <sect>Editing an ext2 filesystem
  536. <p>
  537.  
  538. In order to edit an ext2 filesystem, you should, of course, know the structure
  539. of the ext2 filesystem. If you feel that you lack some knowledge in this
  540. area, I suggest that you do some of the following:
  541. <itemize>
  542. <item>    Read the supplied ext2 technical information. I tried to summarize
  543.     the basic information which is needed to get you started.
  544. <item>    Get the slides that Remy Card (The author of the ext2 filesystem)
  545.     prepared concerning the ext2 filesystem.
  546. <item>    Read the kernel sources.
  547. </itemize>
  548. At this point, you should be familiar with the following terms:
  549. <tt>block, inode, superblock, block groups, block allocation bitmap, inode
  550. allocation bitmap, group descriptors, file, directory.</>Most of the above
  551. are objects in EXT2ED.
  552.  
  553. When editing an ext2 filesystem it is recommended that you use the ext2
  554. specific commands, rather then the general commands  <tt>setoffset</> and
  555. <tt>settype</>, mainly because:
  556. <enum>
  557. <item>    In most cases it will be unreliable, and will display incorrect
  558.     information.
  559.  
  560.     Sometimes in order to edit an object, EXT2ED needs the information
  561.     of some other related objects. For example, when editing a
  562.     directory, EXT2ED needs access to the inode of the edited directory.
  563.     Simply setting the type to a directory <tt>will be unreliable</>,
  564.     since the object assumes that you passed through its inode to reach
  565.     it, and expects this information, which isn't initialized if you
  566.     directly set the type to a directory.
  567. <item>    EXT2ED offers far better tools for handling the ext2 filesystem
  568.     using the ext2 specific commands.
  569. </enum>
  570.  
  571. <sect>ext2 general commands
  572. <p>
  573.  
  574. The <tt>ext2 general commands</> are available only when you are editing an
  575. ext2 filesystem. They are <tt>general</> in the sense that they are not
  576. specific to some object, and can be invoked anytime.
  577.  
  578. <sect1><label id="general_superblock">super
  579. <p>
  580. <tscreen><verb>
  581. Syntax: super
  582. </verb></tscreen>
  583. The <tt>super</> command will "bring you" to the main superblock copy. It
  584. will automatically set the object type to <tt>ext2_super_block</>. Then you
  585. will be able to view and edit the superblock. When you are in the
  586. superblock, other commands will be available.
  587.  
  588. <sect1>group
  589. <p>
  590. <tscreen><verb>
  591. Syntax: group [number]
  592. </verb></tscreen>
  593. The <tt>group</> command will "bring you" to the main copy of the
  594. <em>number</> group descriptor. It will automatically set the object type to
  595. <tt>ext2_group_desc</>. Then you will be able to view and edit the group
  596. descriptor entry. When you are there, other commands will be available.
  597.  
  598. <sect1>cd
  599. <p>
  600. <tscreen><verb>
  601. Syntax: cd path
  602. </verb></tscreen>
  603. The <tt>cd</> command will let you travel in the filesystem in the nice way
  604. that the mounted filesystem would have let you.
  605.  
  606. The <tt>cd</> command is a complicated command. Although it may sound
  607. simple at first, an implementation of a typical cd requires passing through
  608. the group descriptors, inodes, directory entries, etc. For example:
  609.  
  610. The innocent cd /usr command can be done by using more primitive
  611. EXT2ED commands in the following way (It is implemented exactly this way):
  612. <enum>
  613. <item>    Using <tt>group 0</> to go to the first group descriptor.
  614. <item>    Using <tt>inode</> to get to the Bad blocks inode.
  615. <item>    Using <tt>next</> to pass to the root directory inode.
  616. <item>    Using <tt>dir</> to see the directory.
  617. <item>    Using <tt>next</> until we find the directory usr.
  618. <item>    Using <tt>followinode</> to pass to the inode corresponding to usr.
  619. <item>    Using <tt>dir</> to see the directory of /usr.
  620. </enum>
  621. And those commands aren't that primitive; For example, the tracing of the
  622. blocks which belong to the root directory is done automatically by the dir
  623. command behind the scenes, and the followinode command will automatically
  624. "run" to the correct group descriptor in order to find the required inode.
  625.  
  626. The path to the <tt>general cd</> command needs to be a full pathname -
  627. Starting from <tt>/</>. The <tt>cd</> command stops at the last reachable
  628. point, which can be a directory entry, in which case the type will be set to
  629. <tt>dir</>, or an inode, in which case the type will be set to
  630. <tt>ext2_inode</>. Symbolic links (Only fast symbolic links, meanwhile) are
  631. automatically followed (if they are not across filesystems, of-course). If
  632. the type is set to <tt>dir</>, you can use a path relative to the 
  633. "current directory".
  634.  
  635. <sect>The superblock
  636. <p>
  637. The superblock can always be reached by the ext2 general command
  638. <tt>super</>. Cross reference section <ref id="general_superblock">.
  639.  
  640. The status window will show you which copy of the superblock copies you are
  641. currently editing.
  642.  
  643. The main data window will show you the values of the various superblock
  644. variables, along with some interpretation of the values.
  645.  
  646. Data can be changed with the <tt>set</> and <tt>writedata</> commands.
  647. <tscreen><verb>
  648. For example, set s_r_blocks_count=1400 will reserve 1400 blocks for root.
  649. </verb></tscreen>
  650.  
  651. <sect1>gocopy
  652. <p>
  653. <tscreen><verb>
  654. Syntax: gocopy number
  655. </verb></tscreen>
  656. The <tt>gocopy</> command will "bring you" to the backup copy <em>number</>
  657. of the superblock copies. <tt>gocopy 0</>, for example, will bring you to
  658. the main copy.
  659.  
  660. <sect1>setactivecopy
  661. <p>
  662. <tscreen><verb>
  663. Syntax: setactivecopy
  664. </verb></tscreen>
  665. The <tt>setactivecopy</> command will copy the contents of the current
  666. superblock copy onto the contents of the main copy. It will also switch to
  667. editing of the main copy. No actual data is written to disk, of-course,
  668. until you issue the <tt>writedata</> command.
  669.  
  670. <sect>The group descriptors
  671. <p>
  672. The group descriptors can be edited by the <tt>group</> command.
  673.  
  674. The status window will indicate the current group descriptor, the total
  675. number of group descriptors (and hence of group blocks), and the backup copy
  676. number.
  677.  
  678. The main data window will just show you the values of the various variables.
  679.  
  680. Basically, you can use the <tt>next</> and <tt>prev</> commands, along with the
  681. <tt>set</> command, to modify the group descriptors.
  682.  
  683. The group descriptors object is a junction, from which you can reach:
  684. <itemize>
  685. <item>    The inode table of the corresponding block group (the <tt>inode</>
  686.     command)
  687. <item>    The block allocation bitmap (the <tt>blockbitmap</> command)
  688. <item>    The inode allocation bitmap (the <tt>inodebitmap</> command)
  689. </itemize>
  690.  
  691. <sect1>blockbitmap
  692. <p>
  693. <tscreen><verb>
  694. Syntax: blockbitmap
  695. </verb></tscreen>
  696. The <tt>blockbitmap</> command will let you edit the block bitmap allocation
  697. block of the current group block.
  698.  
  699. <sect1>entry
  700. <p>
  701. <tscreen><verb>
  702. Syntax: entry number
  703. </verb></tscreen>
  704. The <tt>entry</> command will move you to the <em>number</> group descriptor in the
  705. group descriptors table.
  706.  
  707. <sect1>inode
  708. <p>
  709. <tscreen><verb>
  710. Syntax: inode
  711. </verb></tscreen>
  712. The <tt>inode</> command will pass you to the first inode in the current
  713. group block.
  714.  
  715. <sect1>inodebitmap
  716. <p>
  717. <tscreen><verb>
  718. Syntax: inodebitmap
  719. </verb></tscreen>
  720. The <tt>inodebitmap</> command will let you edit the inode bitmap allocation
  721. block of the current group block.
  722.  
  723. <sect1>next
  724. <p>
  725. <tscreen><verb>
  726. Syntax: next [number]
  727. </verb></tscreen>
  728. The <tt>next</> command will pass to the next <em>number</> group
  729. descriptor. If <em>number</> is omitted, <em>number=1</> is assumed.
  730.  
  731. <sect1>prev
  732. <p>
  733. <tscreen><verb>
  734. Syntax: prev [number]
  735. </verb></tscreen>
  736. The <tt>prev</> command will pass to the previous <em>number</> group
  737. descriptor. If <em>number</> is omitted, <em>number=1</> is assumed.
  738.  
  739. <sect1>setactivecopy
  740. <p>
  741. <tscreen><verb>
  742. Syntax: setactivecopy
  743. </verb></tscreen>
  744. The <tt>setactivecopy</> command copies the contents of the current group
  745. descriptor, to its main copy. The updated main copy will then be shown. No
  746. actual change is made to the disk until you issue the <tt>writedata</>
  747. command.
  748.  
  749. <sect>The inode
  750. <p>
  751. An inode can be reached by the following two ways:
  752. <itemize>
  753. <item>    Using <tt>inode</> from the corresponding group descriptor.
  754. <item>    Using <tt>followinode</> from a directory entry.
  755. <item>    Using the <tt>cd</> command with the pathname to the file.
  756.  
  757.     For example, <tt>cd /usr/src/ext2ed/ext2ed.h</>
  758. </itemize>
  759.  
  760. The status window will indicate:
  761. <itemize>
  762. <item>    The current global inode number.
  763. <item>    The total total number of inodes.
  764. <item>    On which block group the inode is allocated.
  765. <item>    The total number of inodes in this group block.
  766. <item>    The index of the current inode in the current group block.
  767. <item>    The type of the inode (file, directory, special, etc).
  768. </itemize>
  769.  
  770. The main data window, in addition to the list of variables, will contain
  771. some interpretations on the right side.
  772.  
  773. If the inode corresponds to a file, you can use the <tt>file</> command to
  774. edit the file.
  775.  
  776. If the inode is an inode of a directory, you can use the <tt>dir</> command
  777. to edit the directory.
  778.  
  779. <sect1>dir
  780. <p>
  781. <tscreen><verb>
  782. Syntax: dir
  783. </verb></tscreen>
  784. If the inode mode corresponds to a directory (shown on the status window),
  785. you can enter directory mode editing by using <tt>dir</>.
  786.  
  787. <sect1>entry
  788. <p>
  789. <tscreen><verb>
  790. Syntax: entry number
  791. </verb></tscreen>
  792. The <tt>entry</> command will move you to the <em>number</> inode in the
  793. current inode table.
  794.  
  795. <sect1>file
  796. <p>
  797. <tscreen><verb>
  798. Syntax: file
  799. </verb></tscreen>
  800. If the inode mode corresponds to a file (shown on the status window),
  801. you can enter file mode editing by using <tt>file</>.
  802.  
  803. <sect1>group
  804. <p>
  805. <tscreen><verb>
  806. Syntax: group
  807. </verb></tscreen>
  808. The <tt>group</> command is used to go to the group descriptor of the
  809. current group block.
  810.  
  811. <sect1>next
  812. <p>
  813. <tscreen><verb>
  814. Syntax: next [number]
  815. </verb></tscreen>
  816. The <tt>next</> command will pass to the next <em>number</> inode.
  817. If <em>number</> is omitted, <em>number=1</> is assumed.
  818.  
  819. <sect1>prev
  820. <p>
  821. <tscreen><verb>
  822. Syntax: prev [number]
  823. </verb></tscreen>
  824. The <tt>prev</> command will pass to the previous <em>number</> inode.
  825. If <em>number</> is omitted, <em>number=1</> is assumed.
  826.  
  827. <sect>The file
  828. <p>
  829. When editing a file, EXT2ED offers you a both a continuous and a true
  830. fragmented view of the file - The file is still shown block by block with
  831. the true block number at each stage and EXT2ED offers you commands which
  832. allow you to move between the <tt>file blocks</>, while finding the
  833. allocated blocks by using the inode information behind the scenes.
  834.  
  835. Aside from this, the editing is just a <tt>hex editing</> - You move the
  836. cursor in the current block of the file by using <tt>next</> and
  837. <tt>prev</>, move between blocks by <tt>nextblock</> and <tt>prevblock</>,
  838. and make changes by the <tt>set</> command. Note that the set command is
  839. overridden here - There are no variables. The <tt>writedata</> command will
  840. update the current block to the disk.
  841.  
  842. Reaching a file can be done by using the <tt>file</> command from its inode.
  843. The <tt>inode</> can be reached by any other means, for example, by the
  844. <tt>cd</> command, if you know the file name.
  845.  
  846. The status window will indicate:
  847. <itemize>
  848. <item>    The global block number.
  849. <item>    The internal file block number.
  850. <item>    The file offset.
  851. <item>    The file size.
  852. <item>    The file inode number.
  853. <item>    The indirection level - Whether it is a direct block (0), indirect
  854.     (1), etc.
  855. </itemize>
  856.  
  857. The main data window will display the file either in hex mode or in text
  858. mode, select-able by the <tt>display</> command.
  859.  
  860. In hex mode, EXT2ED will display offsets in the current block, along with a
  861. text and hex dump of the current block.
  862.  
  863. In either case the <tt>current place</> will be highlighted. In the hex mode
  864. it will be always highlighted, while in the text mode it will be highlighted
  865. if the character is display-able.
  866.  
  867. <sect1>block
  868. <p>
  869. <tscreen><verb>
  870. Syntax: block block_num
  871. </verb></tscreen>
  872. The <tt>block</> command is used to move inside the file. The
  873. <em>block_num</> argument is the requested internal file block number. A
  874. value of 0 will reach the beginning of the file.
  875.  
  876. <sect1>display
  877. <p>
  878. <tscreen><verb>
  879. Syntax: display [text || hex]
  880. </verb></tscreen>
  881. The <tt>display</> command changes the display mode of the file. <tt>display
  882. hex</> will switch to <tt>hex mode</>, while <tt>display text</> will switch
  883. to text mode. The default mode when no <tt>display</> command is issued is
  884. <tt>hex mode</>.
  885.  
  886. <sect1>inode
  887. <p>
  888. <tscreen><verb>
  889. Syntax: inode
  890. </verb></tscreen>
  891. The <tt>inode</> command will return to the inode of the current file.
  892.  
  893. <sect1>next
  894. <p>
  895. <tscreen><verb>
  896. Syntax: next [num]
  897. </verb></tscreen>
  898. The <tt>next</> command will pass to the next byte in the file. If
  899. <em>num</> is supplied, it will pass to the next <em>num</> bytes.
  900.  
  901. <sect1>nextblock
  902. <p>
  903. <tscreen><verb>
  904. Syntax: nextblock [num]
  905. </verb></tscreen>
  906. The <tt>nextblock</> command will pass to the next block in the file. If
  907. <em>num</> is supplied, it will pass to the next <em>num</> blocks.
  908.  
  909. <sect1>prev
  910. <p>
  911. <tscreen><verb>
  912. Syntax: prev [num]
  913. </verb></tscreen>
  914. The <tt>prev</> command will pass to the previous byte in the file. If
  915. <em>num</> is supplied, it will pass to the previous <em>num</> bytes.
  916.  
  917. <sect1>prevblock
  918. <p>
  919. <tscreen><verb>
  920. Syntax: prevblock [num]
  921. </verb></tscreen>
  922. The <tt>nextblock</> command will pass to the previous block in the file. If
  923. <em>num</> is supplied, it will pass to the previous <em>num</> blocks.
  924.  
  925. <sect1>offset
  926. <p>
  927. <tscreen><verb>
  928. Syntax: offset file_offset
  929. </verb></tscreen>
  930. The <tt>offset</> command will move to the specified offset in the file.
  931.  
  932. <sect1>set
  933. <p>
  934. <tscreen><verb>
  935. Syntax: set [text || hex] arg1 [arg2 arg3 ...]
  936. </verb></tscreen>
  937. The <tt>file set</> command is working like the <tt>general set command</>,
  938. with <tt>type=none</>. There are no variables.
  939.  
  940. <sect1>writedata
  941. <p>
  942. <tscreen><verb>
  943. Syntax: writedata
  944. </verb></tscreen>
  945. The <tt>writedata</> command will update the current file block in the disk.
  946.  
  947. <sect>The directory
  948. <p>
  949. When editing a file, EXT2ED analyzes for you both the allocation blocks of
  950. the directory entries, and the directory entries.
  951.  
  952. Each directory entry is displayed on one row. You can move the highlighted
  953. entry with the usual <tt>next</> and <tt>prev</> commands, and "dive in"
  954. with the <tt>followinode</> command.
  955.  
  956. The status window will indicate:
  957. <itemize>
  958. <item>    The directory entry number.
  959. <item>    The total number of directory entries in this directory.
  960. <item>    The current global block number.
  961. <item>    The current offset in the entire directory - When viewing the
  962.     directory as a continuous file.
  963. <item>    The inode number of the directory itself.
  964. <item>    The indirection level - Whether it is a direct block (0), indirect
  965.     (1), etc.
  966. </itemize>
  967.  
  968. <sect1>cd
  969. <p>
  970. <tscreen><verb>
  971. Syntax: cd [path]
  972. </verb></tscreen>
  973. The <tt>cd</> command is used in the usual meaning, like the global cd
  974. command.
  975. <itemize>
  976. <item>    If <em>path</> is not specified, the current directory entry is
  977.     followed.
  978. <item>    <em>path</> can be relative to the current directory.
  979. <item>    <em>path</> can also end up in a file, in which case the file inode
  980.     will be reached.
  981. <item>    Symbolic link (fast only, meanwhile) is automatically followed.
  982. </itemize>
  983.  
  984. <sect1>entry
  985. <p>
  986. <tscreen><verb>
  987. Syntax: entry [entry_num]
  988. </verb></tscreen>
  989. The <tt>entry</> command sets <em>entry_num</> as the current directory
  990. entry.
  991.  
  992. <sect1>followinode
  993. <p>
  994. <tscreen><verb>
  995. Syntax: followinode
  996. </verb></tscreen>
  997. The <tt>followinode</> command will move you to the inode pointed by the
  998. current directory entry.
  999.  
  1000. <sect1>inode
  1001. <p>
  1002. <tscreen><verb>
  1003. Syntax: inode
  1004. </verb></tscreen>
  1005. The <tt>inode</> command will return you to the parent inode of the whole
  1006. directory listing.
  1007.  
  1008. <sect1>next
  1009. <p>
  1010. <tscreen><verb>
  1011. Syntax: next [num]
  1012. </verb></tscreen>
  1013. The <tt>next</> command will pass to the next directory entry.
  1014. If <em>num</> is supplied, it will pass to the next <em>num</> entries.
  1015.  
  1016. <sect1>prev
  1017. <p>
  1018. <tscreen><verb>
  1019. Syntax: prev [num]
  1020. </verb></tscreen>
  1021. The <tt>prev</> command will pass to the previous directory entry.
  1022. If <em>num</> is supplied, it will pass to the previous <em>num</> entries.
  1023.  
  1024. <sect1>writedata
  1025. <p>
  1026. <tscreen><verb>
  1027. Syntax: writedata
  1028. </verb></tscreen>
  1029. The <tt>writedata</> command will write the current directory entry to the
  1030. disk.
  1031.  
  1032. <sect><label id="block_bitmap">The block allocation bitmap
  1033. <p>
  1034. The <tt>block allocation bitmap</> of any block group can be reached from
  1035. the corresponding group descriptor.
  1036.  
  1037. You will be offered a bit listing of the entire blocks in the group. The
  1038. current block will be highlighted and its number will be displayed in the
  1039. status window.
  1040.  
  1041. A value of "1" means that the block is allocated, while a value of "0"
  1042. signals that it is free. The value is also interpreted in the status
  1043. window. You can use the usual <tt>next/prev</> commands, along with the
  1044. <tt>allocate/deallocate</> commands.
  1045.  
  1046. <sect1>allocate
  1047. <p>
  1048. <tscreen><verb>
  1049. Syntax: allocate [num]
  1050. </verb></tscreen>
  1051. The <tt>allocate</> command allocates <em>num</> blocks, starting from the
  1052. highlighted position. If <em>num</> is not specified, <em>num=1</> is assumed.
  1053. Of-course, no actual change is made until you issue a <tt>writedata</> command. 
  1054.  
  1055. <sect1>deallocate
  1056. <p>
  1057. <tscreen><verb>
  1058. Syntax: deallocate [num]
  1059. </verb></tscreen>
  1060. The <tt>deallocate</> command deallocates <em>num</> blocks, starting from the
  1061. highlighted position. If <em>num</> is not specified, <em>num=1</> is assumed.
  1062. Of-course, no actual change is made until you issue a <tt>writedata</> command. 
  1063. <tt>writedata</> command.
  1064.  
  1065. <sect1>entry
  1066. <p>
  1067. <tscreen><verb>
  1068. Syntax: entry [entry_num]
  1069. </verb></tscreen>
  1070. The <tt>entry</> command sets the current highlighted block to
  1071. <em>entry_num</>.
  1072.  
  1073. <sect1>next
  1074. <p>
  1075. <tscreen><verb>
  1076. Syntax: next [num]
  1077. </verb></tscreen>
  1078. The <tt>next</> command will pass to the next bit, which corresponds to the
  1079. next block. If <em>num</> is supplied, it will pass to the next <em>num</>
  1080. bits.
  1081.  
  1082. <sect1>prev
  1083. <p>
  1084. <tscreen><verb>
  1085. Syntax: prev [num]
  1086. </verb></tscreen>
  1087. The <tt>prev</> command will pass to the previous bit, which corresponds to the
  1088. previous block. If <em>num</> is supplied, it will pass to the previous
  1089. <em>num</> bits.
  1090.  
  1091. <sect>The inode allocation bitmap
  1092. <p>
  1093.  
  1094. The <tt>inode allocation bitmap</> is very similar to the block allocation
  1095. bitmap explained above. It is also reached from the corresponding group
  1096. descriptor. Please refer to section <ref id="block_bitmap">.
  1097.  
  1098. <sect>Filesystem size limitation
  1099. <p>
  1100.  
  1101. While an ext2 filesystem has a size limit of <tt>4 TB</>, EXT2ED currently
  1102. <tt>can't</> handle filesystems which are <tt>bigger than 2 GB</>.
  1103.  
  1104. I am sorry for the inconvenience. This will hopefully be fixed in future
  1105. releases.
  1106.  
  1107. <sect>Copyright
  1108. <p>
  1109.  
  1110. EXT2ED is Copyright (C) 1995 Gadi Oxman.
  1111.  
  1112. EXT2ED is hereby placed under the GPL - Gnu Public License. You are free and
  1113. welcome to copy, view and modify the sources. My only wish is that my
  1114. copyright presented above will be left and that a list of the bug fixes,
  1115. added features, etc, will be provided.
  1116.  
  1117. The entire EXT2ED project is based, of-course, on the kernel sources. The
  1118. <tt>ext2.descriptors</> distributed with EXT2ED is a slightly modified
  1119. version of the main ext2 include file, /usr/include/linux/ext2_fs.h. Follows
  1120. the original copyright:
  1121.  
  1122. <tscreen><verb>
  1123. /*
  1124.  *  linux/include/linux/ext2_fs.h
  1125.  *
  1126.  * Copyright (C) 1992, 1993, 1994, 1995
  1127.  * Remy Card (card@masi.ibp.fr)
  1128.  * Laboratoire MASI - Institut Blaise Pascal
  1129.  * Universite Pierre et Marie Curie (Paris VI)
  1130.  *
  1131.  *  from
  1132.  *
  1133.  *  linux/include/linux/minix_fs.h
  1134.  *
  1135.  *  Copyright (C) 1991, 1992  Linus Torvalds
  1136.  */
  1137.  
  1138. </verb></tscreen>
  1139.  
  1140. <sect>Acknowledgments
  1141. <p>
  1142.  
  1143. EXT2ED was constructed as a student project in the software
  1144. laboratory of the faculty of electrical-engineering in the
  1145. <tt>Technion - Israel's institute of technology</>.
  1146.  
  1147. At first, I would like to thank <tt>Avner Lottem</> and <tt>Doctor Ilana
  1148. David</> for their interest and assistance in this project.
  1149.  
  1150. I would also like to thank the following people, who were involved in the
  1151. design and implementation of the ext2 filesystem kernel code and support
  1152. utilities:
  1153. <itemize>
  1154. <item>    <tt>Remy Card</>
  1155.  
  1156.     Who designed, implemented and maintains the ext2 filesystem kernel
  1157.     code, and some of the ext2 utilities. Remy Card is also the author
  1158.     of several helpful slides concerning the ext2 filesystem.
  1159.     Specifically, he is the author of <tt>File Management in the Linux
  1160.     Kernel</> and of <tt>The Second Extended File System - Current State,
  1161.     Future Development</>.
  1162.  
  1163. <item>    <tt>Wayne Davison</>
  1164.  
  1165.     Who designed the ext2 filesystem.
  1166. <item>    <tt>Stephen Tweedie</>
  1167.  
  1168.     Who helped designing the ext2 filesystem kernel code and wrote the
  1169.     slides <tt>Optimizations in File Systems</>.
  1170. <item>    <tt>Theodore Ts'o</>
  1171.  
  1172.     Who is the author of several ext2 utilities and of the ext2 library
  1173.     <tt>libext2fs</> (which I didn't use, simply because I didn't know
  1174.     it exists when I started to work on my project).
  1175. </itemize>
  1176.  
  1177. Lastly, I would like to thank, of-course, <tt>Linus Torvalds</> and the
  1178. <tt>Linux community</> for providing all of us with such a great operating
  1179. system.
  1180.  
  1181. Please contact me in a case of bug report, suggestions, or just about
  1182. anything concerning EXT2ED.
  1183.  
  1184. Enjoy,
  1185.  
  1186. Gadi Oxman <tgud@tochnapc2.technion.ac.il>
  1187.  
  1188. Haifa, August 95
  1189. </article>